/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.table.procedure;

import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment;

/** A context to provide necessary context used by stored procedure. */
@PublicEvolving
public interface ProcedureContext {

    /**
     * Return the {@link StreamExecutionEnvironment} where the procedure is called. Flink will
     * create a new {@link StreamExecutionEnvironment} based on the current configuration and pass
     * it to the procedure for every procedure call. The procedure can modify the passed
     * StreamExecutionEnvironment safely inside as it won't be leaked outside.
     */
    StreamExecutionEnvironment getExecutionEnvironment();
}
